CIMPLICITY Configuration REST API Web Service
CIMPLICITY Configuration REST API Web Service / All Operations Resource Group / /projects/{projectId}/users (Get)
In This Topic
    Get/projects/{projectId}/users
    In This Topic
    Description
    returns a list of users in a project that satisfy the filter criteria
    Parameters
    NameDescriptionData Type
    projectIdthe id of the project to look instring
    skipnumber of records to skip for paginationinteger (int32)
    limitmaximum number of records to returninteger (int32)
    UserIDprovides a wild card string to filter users by their UserID.string
    RoleIDprovides a wild card string to filter users using their corresponding RoleID.string
    200 Response

    The response body is of type UsersGetResponse.

    The collection of users that satisfy the query.

    Overview

    UsersGetResponse
    The results of the users get query.
    Users : Array[CimUser]
    AuthenticationType : CimUserType
    Enable : boolean
    PasswordExpiresInDays : number
    Password : string
    Resources : Array[string]
    RoleID : string
    UserID : string
    UserName : string
    Fault Responses
    FaultDescription
    404This fault returns a response body of type ProblemDetails.
    project with the given id is not registered on the system
    See Also
    All Operations Resource Group | CIMPLICITY Configuration REST API Web Service

     

     

    © 2024 GE Vernova and/or its affiliates. All rights reserved.

    Send comments on this topic.